org.eclipse.vtp.desktop.projects.core
Interface IMediaResource

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IVoiceToolsResource
All Known Subinterfaces:
IAudioFile, IGrammarFile, IMediaFile, IMediaFolder
All Known Implementing Classes:
AudioFile, GrammarFile, MediaFile, MediaFolder, MediaResource

public interface IMediaResource
extends IVoiceToolsResource

This abstract interface represents a generic file or folder media resource. It provides functions that allow upwards traversal of the resource tree and simple informational retrieval.

Version:
2.0
Author:
Trip Gilman

Method Summary
 void delete()
          Removes this resource from the project structure.
 boolean exists()
          Determines if this media resource exists.
 java.lang.String getMediaPath()
           
 IMediaContainer getParentMediaContainer()
           
 
Methods inherited from interface org.eclipse.vtp.desktop.projects.core.IVoiceToolsResource
addRefreshListener, deferEvents, getName, getParent, getProject, refresh, removeRefreshListener, resumeEvents
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getParentMediaContainer

IMediaContainer getParentMediaContainer()
Returns:
The parent media container of this media resource

exists

boolean exists()
Determines if this media resource exists.

Returns:
true if the resource exists, false otherwise

delete

void delete()
            throws org.eclipse.core.runtime.CoreException
Removes this resource from the project structure. If this resource is a folder, all items under the resource will also be removed as part of this action.

Throws:
org.eclipse.core.runtime.CoreException - If an error occured during the deletion

getMediaPath

java.lang.String getMediaPath()
Returns:
A string representation of this media resource relative to the top level media files folder of this brand or persona project